home *** CD-ROM | disk | FTP | other *** search
/ Libris Britannia 4 / science library(b).zip / science library(b) / PROGRAMM / OTHER_LA / 0289.ZIP / UTILSDOC.TXT < prev   
Text File  |  1986-11-19  |  23KB  |  520 lines
  1. ASMSTAT
  2.     This utility program compiles some interesting statistics about assembly
  3.     language programs.  It reads in assembly language programs (formatted
  4.     according to the rules for Microsoft's MS/DOS assembler, although it
  5.     would probably work with most compatible-format assembly languages) and
  6.     produces statistics indicating the ratio of comment keystrokes to program
  7.     keystrokes, and many other interesting statistics.  It is surprising
  8.     to see how closely an individual programmer's statistics end up being,
  9.     even in quite different programs.  This program can also be used to
  10.     "screen" a series of programs, to see which might need be checked for
  11.     adequate commenting.  The program is invoked with a command line of
  12.     the form:
  13.  
  14.     snorun asmstat <<inputfilespec>
  15.  
  16.     Note that the first of the left-pointy-brackets above is used in the
  17.     actual command line to redirect the input to the program from the file
  18.     indicated by <inputfilespec>.  Alternatively, this first "<" character
  19.     may be replaced by "/5:" or "/5=".  (These are generally the three ways
  20.     to redirect the input file to any program based on SNORUN).  
  21.  
  22.       Example command lines would look like:
  23.  
  24.     snorun asmstat <c:\asm\prog1.asm
  25.     snorun asmstat <myprog.asm
  26.  
  27.  
  28. DIFFER
  29.     This utility program compares two text files and indicates how many areas
  30.     in the file have been changed.  A report is produced to compare the
  31.     changed areas.  
  32.       The program is basically the work of P.R. Tallett, Datacall Ltd, 
  33.     Kirkstall Rd., Leeds, England.  It has been elaborated somewhat by A. P.
  34.     McCann.  Inclusion of line numbers and slight rework for the IBM PC
  35.     version has been done by David Shields and Robert Dewar.  Several bugs
  36.     in command line scanning and end-of-file handling have been corrected
  37.     by Gordon Peterson II.
  38.       The program is invoked by a command line of the form:
  39.  
  40.     differ <file1> <file2> <outfile> [<options>] 
  41.  
  42.       The first two file specs define the two input files to be compared,
  43.     and these two must be present.  The third file spec, if present,
  44.     defines where the output file is to go.  This can be either a disk file
  45.     or a device (such as CON, PRN, or LPTn).  If no output file is specified,
  46.     the console is assumed.  (Note that if the /W format is being routed to
  47.     the console, it is much more readable if /W39 is specified).
  48.  
  49.     <options>::
  50.        /M
  51.       This option forces blank lines to match in compared files.  The
  52.       default is that blank lines are ignored during the matching
  53.       process.
  54.  
  55.        /L[n][+]
  56.       This option specifies that "n" lines must be found identical before
  57.       the program can assume the files are again in parallel.  The 
  58.       default is 3.  If the + is found, then the listing includes the
  59.       n lines which were the same.  The default is that only the first
  60.       such line matching gets included in the listing.
  61.  
  62.        /Rc
  63.       Normally, any character found in either input file less than 20H
  64.       is replaced by a "?" character in the output report.  If this
  65.       option is specified, the character specified as "c" specifies an
  66.       alternate replacement character to use instead.
  67.  
  68.        /X
  69.       This option prevents the replacement of characters less than 20H
  70.       in the output report.  (They are retained and output as found in 
  71.       the input files).  
  72.  
  73.        /W[n][-]
  74.       This option specifies that a double column listing format is to be
  75.       used.  Use of this option is recommended.  The first "n" characters
  76.       of each line (one from file1, one from file2) are printed side by
  77.       side, making the comparison easier.  The total line length is 2n + 2
  78.       including the separator characters.  Default is 65.  The "-" sign,
  79.       if present, reduces the length of the line of asterisks separating
  80.       the blocks of different code.  The "-" option, which might be useful
  81.       on slow printers, is not really recommended.
  82.  
  83.        Example:
  84.       To compare "OLDVER.TXT" with "NEWVER.TXT" and print a file of the
  85.       changes, the suggested command line would be:
  86.  
  87.       differ oldver.txt newver.txt prn /W
  88.     
  89.  
  90. DIRCMP2
  91.     This utility program allows comparing the files within specified
  92.     directories.  The directories may be on the same or different disk
  93.     volumes, and may also be network volumes running within, for example,
  94.     PC network.  The program is invoked with a command line of the form:
  95.  
  96.     snorun dircmp2 ;CMDFILE=<cmdfile>[,BATFILE=<outputfile>]
  97.  
  98.     The CMDFILE contains entries of the form:
  99.  
  100.     MATCH  C:\,D:\
  101.     MATCH  D:\ASM\SRCPROG,F:\ASM\SRCPROG
  102.     MATCH  D:\PROG,D:\PROG\BACKUP
  103.  
  104.     Each of these entries define a pair of subdirectories (and the drives on
  105.     which they are located) which are to be compared.  There are three
  106.     output streams from the program:
  107.  
  108.     Display output (written to SCREEN) includes progress messages which
  109.     are displayed on the screen as each new directory is read from the
  110.     specified drive.  
  111.  
  112.     Standard output (written to OUTPUT) includes an echo of each entered
  113.     command received.  This is followed by a listing of all files in the
  114.     two subdirectories which are of different age or size, as well as those
  115.     which are missing from one or the other of the directories.  Note that
  116.     the program will not process MATCH commands where one or the other of
  117.     the two subdirectories is missing or contains no files (and lower-
  118.     level subdirectories do not count as a file for the purpose of this
  119.     test!)  This stream is normally redirected to either the printer or an
  120.     output file for subsequent analysis.  
  121.  
  122.     Batch output (written if the BATFILE= option is specified) consists of
  123.     a batch file which includes COPY commands which update older versions
  124.     of files from the newer versions, and copies over files which previously
  125.     were missing from one or the other of the corresponding subdirectories.
  126.  
  127.     DIRCMP2 is a very useful tool for maintaining, for example, a series of
  128.     subdirectories which include files being maintained by separate
  129.     programmers.  It also is very useful if a programmer is maintaining
  130.     a file server subdirectory, but updates his own personal copy on his
  131.     own machine and then periodically wants to update the later versions
  132.     to the generally-available copies on the file server.  
  133.  
  134.  
  135. DIRTREE
  136.     This utility program allows listing subdirectory information on either
  137.     an entire volume or within any specified subdirectory of a volume.  All
  138.     options may be entered in either upper or lower case.  The output file
  139.     may be redirected in the same way one would redirect any other output
  140.     file produced via SNORUN.  
  141.  
  142.     snorun dirtree [<iooptions>][;<options>]
  143.  
  144.     <iooptions>::
  145.        /6=<outputspec>
  146.           This option allows putting the output of DIRTREE to a disk file
  147.           or to the printer.  Either the equal sign (as shown) or a colon
  148.           are equally valid delimiters for this option.  Example command
  149.           lines are:
  150.         snorun dirtree /6=lpt1: ;path=c:
  151.         snorun dirtree /6=c:\prt\mydirs.prt ;path=d:
  152.  
  153.        ><outputspec>
  154.           The output of DIRTREE may also be routed to a disk file or a
  155.           device by simple redirection.  Example command lines are:
  156.         snorun dirtree >mydirs.prt ;path=d: list
  157.  
  158.        >><outputspec>
  159.       The output of DIRTREE may be appended to a disk file.  To create
  160.       a disk file containing the listings of all valid paths for hard
  161.       drives C: and D:, the command lines might be:
  162.         snorun dirtree >mydirs.txt ;path=c: list
  163.         snorun dirtree >>mydirs.txt ;path=d: list
  164.  
  165.     <options>::
  166.        path=<pathname>   or
  167.        /p=<pathname>     
  168.           This option allows specification of the path name to be used for
  169.           the subdirectory lookup.  Example pathnames are:   
  170.                 c:  a:ms*  d:ms?as*      etc.
  171.           The default path name is "\".
  172.  
  173.        /dpo
  174.           This option causes no subdirectory scanning, but merely displays
  175.           the effective path name that would be used for the lookup.
  176.  
  177.        list        or
  178.        /l
  179.           This option causes all subdirectories to be written to the output
  180.           file.  They are output as FULL PATH NAMES, in sorted, interleaved
  181.           sequence.
  182.  
  183.        indent        or
  184.        /i
  185.           This option causes all subdirectories to be written to the output
  186.           file.  They are output as FULL PATH NAMES, in sorted, interleaved
  187.           sequence, just as for the "list" form, except that nested
  188.           subdirectories are indented.
  189.  
  190.        stair        or
  191.        step        or
  192.        /s
  193.       This option causes all subdirectories to be written to the output
  194.           file.  They are output, one subdirectory to a line (with higher
  195.           levels of each path name suppressed), in sorted, interleaved
  196.           sequence.  The left end of each nested subdirectory is lined up
  197.           under the right hand end of the name of the containing (sub)-
  198.           directory above.  
  199.  
  200.        tree        or
  201.        /t
  202.           This option causes all subdirectories to be written to the output
  203.           file in the style used by PCTOOLS, except in a continuous format
  204.           (PCTOOLS displays them one screenful at a time, making it incon-
  205.           venient to print them).  
  206.  
  207.        nohdr        or
  208.        /nh
  209.           This option suppresses the heading from being written to the output
  210.           file.  The heading contains the path name used, the date and time,
  211.           and the volume name (unless suppressed).
  212.  
  213.        novol        or
  214.        /nv
  215.           This option suppresses the volume name from being accessed.  If
  216.           not suppressed, the volume name is read and placed in the heading
  217.           (which could also be suppressed).
  218.  
  219.  
  220. LIST
  221.     This utility program allows listing a text file with a variety of
  222.     options.
  223.       Note that you may have LIST in either of two forms, the SNOBOL4+
  224.     form (with the extension .SAV) or the SPITBOL form (with the extension
  225.     .EXE).  The command lines are slightly different between the two forms:
  226.     If you have LIST.SAV, use the "snorun" form of the command line;  if
  227.     you have LIST.EXE, use the "list" form of the command line instead.
  228.  
  229.     snorun list ;<inputfile>[,<outputfile>][<options>]        OR:
  230.     list <inputfilespec>[,<outputfile>][<options>]
  231.  
  232.     <outputfile>::
  233.        This item specifies the name of a file to which output is to be
  234.        written.  If no file name is specified, default is to output to
  235.        PRN: (the printer).
  236.  
  237.     <options>::
  238.        /f
  239.       This option specifies that the file being listed is already in
  240.           print file format.  No headings are added, and no numbering of
  241.           lines is done.  The file is assumed to contain no tab characters.
  242.  
  243.        /n<integer>
  244.       This option allows specifying how many input record lines are to
  245.       be printed on each page.  The default is 55.
  246.  
  247.        /p
  248.           This option causes a print file to be generated.  This file
  249.           is formatted for being output to a printer, including page
  250.           headings.  The extension defaults to ".LST" if none is specified.
  251.  
  252.        /q
  253.       This option causes the output to be appended to the end of the
  254.       output file, if it already exists.  If the output file is empty
  255.           or does not already exist, this option has no effect.
  256.  
  257.        /t<integer>
  258.       This option causes any tab characters encountered to be expanded
  259.       so that tabs occur every <integer> columns.  The default is to
  260.       tab every eight columns.
  261.  
  262.        /x
  263.           This option causes numbering of the lines to be suppressed.  The
  264.       default is to number the input records.  The first record number
  265.       is 1.
  266.  
  267.  
  268. MELIZA
  269.     This is a version of the famous "ELIZA" psychoanalysis program, one of
  270.     the earliest famous attempts at "artificial intelligence".  Although
  271.     this program is relatively straightforward, if the subject is persistent
  272.     for a while, and attempts to converse seriously, the program can
  273.     occasionally produce some rather startling insights and is sometimes
  274.     terribly funny.  (ELIZA is the happiest when you talk to her using
  275.     complete sentences.)
  276.  
  277.  
  278. MSCRIBE
  279.     This utility program is similar to the Datapoint MSCRIBE program.  It
  280.     reads in a simply formatted text file, and ends up producing a nicely
  281.     formatted version of the documentation, according to a standard format.
  282.     This is suitable for product specifications, user's guides, and such.
  283.     MSCRIBE works in conjunction with the Borland program SUPERKEY and the
  284.     word processing program WORDSTAR 2000+.  The output macro files are
  285.     kept smaller than 8K bytes, by segmenting them into multiple files (the
  286.     extension of the macro file name is incremented for additional macro
  287.     files, which are automatically linked).  WORDSTAR 2000 should be con-
  288.     figured to support document histories.  Also, before running the "key"
  289.     command below, it is assumed that a format file (same name as the input
  290.     file, but with extension .FRM) exists for the document body, and that
  291.     the format file MSCRIBET.FRM exists (which is used for the title page
  292.     and preface).  The final document is to be found in the resulting files
  293.     with extensions .TIT, .TOC, and .BOD, which are then printed by WORDSTAR.
  294.       Note that you may have MSCRIBE in either of two forms, the SNOBOL4+
  295.     form (with the extension .SAV) or the SPITBOL form (with the extension
  296.     .EXE).  The command lines are slightly different between the two forms:
  297.     If you have MSCRIBE.SAV, use the "snorun" form of the command line;  if
  298.     you have MSCRIBE.EXE, use the "mscribe" form of the command line instead.
  299.  
  300.     snorun mscribe /5:<inputfilespec> /6:<macrofilespec>    OR:
  301.     mscribe /5:<inputfilespec> /6:<macrofilespec>
  302.     key <macrofilespec> /ml
  303.  
  304.     The input file contains text with embedded formatting commands.  These
  305.     commands are all beginning in column one of their record.  Within the
  306.     input file, the following formatting commands are used:
  307.     
  308.     +m1 <projectname>
  309.     This command furnishes the project name for the document.
  310.  
  311.     +m2 <title>
  312.     This command furnishes the title of the document.
  313.  
  314.     +m3 <documenttype>
  315.     This command furnishes the type of document ("User's Guide", "Prelimin-
  316.     ary Specification", or the like).
  317.  
  318.     +m4 <date>
  319.     This command supplies the version date of the document.
  320.  
  321.     +m5
  322.     This command indicates that the following text (beginning with the next
  323.     record) is the Preface for the document.
  324.  
  325.     +m6 <docdescription>
  326.     This command indicates the end of the Preface and supplies the name for
  327.     the Body file (this is keyed into the Document History kept by Wordstar
  328.     for the main part of the document).  It also indicates where the Table
  329.     of Contents is to be inserted.
  330.  
  331.     +m7 0.  <chapterheading>
  332.     This command supplies the heading for each chapter.  The "0" is auto-
  333.     matically replaced by MSCRIBE with the chapter number.
  334.  
  335.     +m8 0.0[[.0].0]    <sectionheading>
  336.     This command supplies the heading for each section, subsection, etc.
  337.     The zeros are automatically replaced by MSCRIBE with the appropriate
  338.     numbers for the given section, subsection, or sub-subsection.  Four
  339.     levels of section numbers are presently supported (more could be
  340.     supported on request, but Wordstar 2000+ only supports four levels in
  341.     its table of contents, hence the restriction).  The number of zeros
  342.     indicate the nesting level.
  343.  
  344.     +pp<n>  (e.g. +pp0, +pp1, etc.)
  345.     This command causes the text following to be the start of a new para-
  346.     graph.  You may start the new paragraph either on the following line or
  347.     on the same line as the +pp<n>, as long as at least one space follows
  348.     the command (and optional number).  New paragraphs are automatically
  349.     assumed after any +m<n> heading command which is followed by text.  
  350.  
  351.     +sl<n>  (e.g. +sl0, +sl1, etc.)
  352.     This command causes the text following (beginning on the following line)
  353.     to be the start of a new paragraph.  You may start the new paragraph
  354.     either on the following line or on the same line as the +sl<n>, as long
  355.     as at least one space follows the command (and optional number).  The 
  356.     only difference between this command and the +pp command is that using 
  357.     this command keeps the new paragraph from being indented.  
  358.  
  359.     +turnoff
  360.     This causes text following it to be ignored, including any +m<n> commands
  361.     that might be encountered, until a +turnon command is encountered.
  362.  
  363.  
  364. OVER
  365.     This utility program is used to shift print files right by a specified
  366.     number of columns.  It is useful, for example, to get a listing of
  367.     a program documentation file which can be put into a binder without the
  368.     leftmost characters of each line becoming buried in the binding.  If
  369.     one or more nonprinting printer control characters are at the beginning
  370.     of each record, they are kept at the beginning and the padding characters
  371.     are inserted following those control characters.
  372.      
  373.     over  <inputfilespec> <outputfilespec> [/n<integer>]
  374.  
  375.     <inputfilespec>::
  376.        file name and extension, with optional drive spec and/or path name,
  377.        defining where the input is to come from.
  378.  
  379.     <outputfilespec>::
  380.        file name and extension, with optional drive spec and/or path name,
  381.        or device name, where the output file is to be placed.  It may also
  382.        be written to a specified device.
  383.  
  384.     /n<integer>::
  385.        This option specifies by how many columns the input file is to be
  386.        shifted to the right.  The default is twenty columns.  The option
  387.        letter "n" may be either upper or lower case.  Examples for this
  388.        option would look like:
  389.         /N16
  390.         /n7
  391.  
  392.     Therefore, example command lines might be:
  393.     
  394.     over  file1  file1ovr  /n5
  395.     over  a:docfile.txt  c:\docfiles\over\docfileo.txt 
  396.  
  397.  
  398. SPACE
  399.     This utility program is an enhanced version of DIRTREE (shown above).  
  400.     Like DIRTREE, it allows listing subdirectory information on either
  401.     an entire volume or within any specified subdirectory of a volume.  
  402.     However, SPACE optionally displays the number of files and sectors
  403.     contained within each subdirectory, broken down by file extension within 
  404.     that subdirectory, and for the entire volume (or highest level path 
  405.     as specified on the command line).  (Note that, throughout the options
  406.     descriptions that follow, ":" and "=" are both equally acceptable
  407.     between an option keyword and its specified value.)  Also, all options
  408.     may be entered in either upper or lower case.
  409.  
  410.     snorun space [<iooptions>][;<options>]
  411.  
  412.     <iooptions>::
  413.        ><outputfile>     or
  414.        >><outputfile>    or
  415.        /6=<outputfile>     or
  416.        /6:<outputfile>
  417.           This option allows specification of a file (or device) to which
  418.           the output file is to be written.  This can be either a printer
  419.           or a disk file, or in general any MS/DOS sequential output device.
  420.  
  421.     <options>::    
  422.        path=<pathname>   or
  423.        /p=<pathname>     
  424.           This option allows specification of the path name to be used for
  425.           the subdirectory lookup.  Example pathnames are:   
  426.                 c:  a:ms*  d:ms?as*      etc.
  427.           The default path name is "\".
  428.  
  429.        alloc        or
  430.        /a
  431.       This option causes the output of space utilization reports which
  432.       are sorted in descending order by amount of space used for files
  433.       of each given extension.  
  434.  
  435.        /dpo
  436.           This option causes no subdirectory scanning, but merely displays
  437.           the effective path name that would be used for the lookup.
  438.  
  439.        dup        or
  440.        /d
  441.       This option causes an analysis and report of possible duplicate
  442.       files.  A report is generated of all files of the exact same
  443.       length and generation time for the specified path(s).  Although
  444.       the data in the files is not actually checked, use of this option
  445.       will generally turn up several files which are needlessly wasting
  446.       space on your hard disk by existing in several places at the same 
  447.       time.  Note that it is not necessary that the file name or 
  448.       extensions be the same for them to turn up on this report.
  449.  
  450.        ext        or
  451.        /x
  452.       This option causes the output of space utilization reports which
  453.       are sorted in alphabetic order of file extension.  This option
  454.       takes precedence over the "alloc" and "/a" options, should both
  455.       be specified.
  456.  
  457.        list        or
  458.        /l
  459.           This option causes all subdirectories to be written to the output
  460.           file.  They are output as FULL PATH NAMES, in sorted, interleaved
  461.           sequence.
  462.  
  463.        indent        or
  464.        /i
  465.           This option causes all subdirectories to be written to the output
  466.           file.  They are output as FULL PATH NAMES, in sorted, interleaved
  467.           sequence, just as for the "list" form, except that nested
  468.           subdirectories are indented.
  469.  
  470.        stair        or
  471.        step        or
  472.        /s
  473.       This option causes all subdirectories to be written to the output
  474.           file.  They are output, one subdirectory to a line (with higher
  475.           levels of each path name suppressed), in sorted, interleaved
  476.           sequence.  The left end of each nested subdirectory is lined up
  477.           under the right hand end of the name of the containing (sub)-
  478.           directory above.  
  479.  
  480.        tree        or
  481.        /t
  482.           This option causes all subdirectories to be written to the output
  483.           file in the style used by PCTOOLS, except in a continuous format
  484.           (PCTOOLS displays them one screenful at a time, making it incon-
  485.           venient to print them).  
  486.  
  487.        util        or
  488.        /u
  489.       This option causes the output of space utilization reports.  These
  490.       reports break down the number of files and number of bytes
  491.       allocated per file extension, per subdirectory.  If more than one
  492.       space utilization report is produced, a summary report is also
  493.       provided at the end which consolidates all of the previously
  494.           produced space utilization reports.  Note that the number of bytes
  495.           allocated as shown in these reports does not include the additional
  496.       unused bytes normally found at the end of each file.  The default
  497.       ordering of these reports is in alphabetic order by file extension.
  498.  
  499.        width=<integer>    or
  500.        /w=<integer>
  501.       This option sets the width of the output lines to the indicated
  502.       maximum width.  The default maximum width is 80.  If the usage
  503.       option is in effect, setting the maximum width to 132 (or some
  504.        value bigger than 80) may result in more columns being able to
  505.       fit per output line.  
  506.  
  507.        nohdr        or
  508.        /nh
  509.           This option suppresses the heading from being written to the output
  510.           file.  The heading contains the path name used, the date and time,
  511.           and the volume name (unless suppressed).
  512.  
  513.        novol        or
  514.        /nv
  515.           This option suppresses the volume name from being accessed.  If
  516.           not suppressed, the volume name is read and placed in the heading
  517.           (which could also be suppressed).
  518.  
  519.  
  520.